Skip to content

[error-tracking] Apply general doc update #28724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
dd-mergequeue merged 18 commits into from
Apr 23, 2025
Merged

[error-tracking] Apply general doc update #28724

dd-mergequeue merged 18 commits into from
Apr 23, 2025

Conversation

@Guillaume-Barrier
Copy link
Contributor

@Guillaume-Barrier Guillaume-Barrier commented Apr 11, 2025 •
edited
Loading

Miscellaneous doc updates of some Error Tracking pages:

  • grouping
  • explorer
  • issue states
  • data collection
  • troubleshooting

📝 See gdoc for tracking

@github-actions github-actions bot added the Images Images are added/removed with this PR label Apr 11, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Apr 11, 2025 •
edited
Loading

Preview links (active after the build_preview check completes)

Modified Files

@Guillaume-Barrier Guillaume-Barrier marked this pull request as ready for review April 14, 2025 12:31
@Guillaume-Barrier Guillaume-Barrier requested a review from a team as a code owner April 14, 2025 12:31
@joepeeples joepeeples added the editorial review Waiting on a more in-depth review label Apr 14, 2025
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
content/en/error_tracking/manage_data_collection.md
- rule 3 (this rule is disabled): team:security
- rule 4: service:foo

The processing flow is as follows:
Copy link
Contributor

@iadjivon iadjivon Apr 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The processing flow is as follows:
The processing flow is as follows:

In this section, it might be helpful to explain the result of the example given. In essence describe the diagram in words. (i.e. what is happening as the flow progresses and what is the end result for this specific event?)

Copy link
Contributor Author

@Guillaume-Barrier Guillaume-Barrier Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can do that! I thought it's pretty clear, we used to have nothing.
Also do we need a proper designer to work on this schematic? I've heard from @meghanlo someone made the diagram we have in issue states.

Copy link
Contributor

@iadjivon iadjivon Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see! Think that the image and steps are wonderful additions. I think an explanation around it might help when users need to create their own steps to satisfy their use cases. Sort of like this explanation for workflows ( but less in-depth

iadjivon
iadjivon requested changes Apr 14, 2025
View reviewed changes
Copy link
Contributor

@iadjivon iadjivon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Guillaume, thanks for these changes. I have made some small changes. Let me know what you think and if you have any questions.

@iadjivon iadjivon self-assigned this Apr 22, 2025
@iadjivon
Copy link
Contributor

iadjivon commented Apr 23, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 23, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-04-23 00:14:48 UTC ℹ️ Start processing command /merge

2025-04-23 00:14:52 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-04-23 04:15:05 UTC ⚠️ MergeQueue: This merge request was unqueued

devflow unqueued this merge request: It did not become mergeable within the expected time

@iadjivon
Copy link
Contributor

iadjivon commented Apr 23, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 23, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-04-23 15:58:42 UTC ℹ️ Start processing command /merge

2025-04-23 15:59:03 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-04-23 19:59:06 UTC ⚠️ MergeQueue: This merge request was unqueued

devflow unqueued this merge request: It did not become mergeable within the expected time

meghanlo
meghanlo approved these changes Apr 23, 2025
View reviewed changes
content/en/error_tracking/explorer.md
Display only issues that have an AI generated fix available to quickly remediate problems.

#### Teams filters

Copy link
Contributor

@meghanlo meghanlo Apr 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we also mention service owners here?

content/en/error_tracking/explorer.md

The lower part of the issue panel gives you the ability to navigate error samples from the related issue. Each error sample gives you troubleshooting information such as the stack trace of the error, and the characteristics of impacted users.

## Get alerted on new errors
Copy link
Contributor

@meghanlo meghanlo Apr 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Get alerted on new errors
## Get alerted on new or impactful errors

@iadjivon
Copy link
Contributor

iadjivon commented Apr 23, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 23, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-04-23 20:57:26 UTC ℹ️ Start processing command /merge

2025-04-23 20:57:33 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 18m (p90).

2025-04-23 21:13:23 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit b8e703a into master Apr 23, 2025
25 of 32 checks passed
@dd-mergequeue dd-mergequeue bot deleted the guillaume.barrier/ERRORT-5095-general-doc-update branch April 23, 2025 21:13
estherk15 pushed a commit that referenced this pull request May 8, 2025
@Guillaume-Barrier @iadjivon @estherk15
[error-tracking] Apply general doc update (#28724)
b95f80a 
Co-authored-by: iadjivon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@meghanlo meghanlo meghanlo approved these changes

@iadjivon iadjivon iadjivon approved these changes

Assignees

@iadjivon iadjivon

Labels

editorial review Waiting on a more in-depth review Images Images are added/removed with this PR mergequeue-status: done

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Guillaume-Barrier @iadjivon @meghanlo @joepeeples